home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / award23.zip / SYSOP.DOC < prev    next >
Text File  |  1993-05-01  |  17KB  |  409 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                         ENTERTAINMENT AWARDS TRIVIA
  11.                               SYSOP'S MANUAL
  12.  
  13.                                   v2.3
  14.  
  15.                               May 1, 1993
  16.                          PCBoard 14.x and GAP 4.x
  17.                            WILDCAT!, SPITFIRE
  18.                              QBBS, RBBS, RA
  19.                                   WWIV
  20.  
  21.                                    by
  22.  
  23.                              Dennis Maidon
  24.                           PAROLE TECHNOLOGIES
  25.                           311 Buffalo Rd
  26.                           Clayton, NC  27520
  27.  
  28.                           (919) 965-3600 -> Voice
  29.                           (919) 965-9885 -> FAX
  30.  
  31.                           The Parole Board BBS
  32.  
  33.               (919) 965-4696 -> US Robotics Dual Standard
  34.  
  35.                             Free Advice BBS
  36.  
  37.                              (919) 934-1002
  38.  
  39.                      US Robotics HST 14.4k / V42bis
  40.  
  41.                            -=-=-=-=-=-=-=-=-
  42.  
  43.                                 OVERVIEW
  44.                                 ________
  45.  
  46.  
  47. CONGRATULATIONS!  You and your users will find this Trivia door
  48. entertaining and educational.  It consists of approximately 100 or
  49. so questions that were carefully selected for your entertainment.
  50. The door displays a "Trivia Royalty" bulletin to the caller while
  51. it creates bulletins and logs for your use.  Best of all..this door
  52. is not crippleware.  It isn't full of advertisements and
  53. limitations...best of all I don't charge an arm and a leg.  You'll
  54. also find we are responsive to your questions.  If you need help or
  55. have a suggestion for improving this product, let me know!
  56.                      FILES AND DESCRIPTIONS
  57.                      ______________________
  58.  
  59. The archive includes the following files:
  60.  
  61.      AWARD.EXE     -- The main executable file
  62.      SAMPLE.CFG     -- The sample configuration file
  63.      AWARD.DAT   -- The main trivia data file
  64.      AWARD.HIS   -- Release History and changes
  65.      SAMPLE.LOG     -- A sample of the log file produced
  66.      SCREENS.ZIP    -- Screens for the AWARD\SCREENS sub directory
  67.          ^┌──WELCOME.ANS  -- The program color Welcome Screen,
  68.          ││                  (Can be modified by Sysop).
  69.          ││  WELCOME.ASC  -- The program mono Welcome Screen
  70.          └┤                  (Can be modified by Sysop).
  71.           │  GAMEPLAY.ANS -- ANSI Game screen ─┐ DO NOT Modify!
  72.           │  GAMEPLAY.ASC -- ASCii Game Screen─┘
  73.           │  INSTRUCT.ANS -- The color user instruction file
  74.           └──INSTRUCT.ASC -- The mono user instruction file
  75.      SYSOP.DOC    -- The installation instructions...(this file)
  76.      QUIKUP.DOC   -- Quick and Dirty installation instructions.
  77.      MAINTAIN.ZIP -- Program to trim the scores database.
  78.      LOCAL.ZIP    -- Sample door.sys and userinfo.dat for
  79.                      local testing.
  80.      REGISTER.TXT -- Information and registration form...This will
  81.                      give you a personalized door, voice or bbs   
  82.                      support services, new issues of master.dat   
  83.                      files, a clear conscience and a still poor but
  84.                      happy door programmer.
  85.      SAMPLE.BAT      Sample door batch file
  86.      
  87. This ZIP file was created using the -AV function of PKZIP.  If my
  88. AV is missing then this file may not be complete or has been
  89. tampered with.  Complete and current editions of this program are
  90. always available for D/L on The Parole Board BBS.  If the AV is
  91. missing please complain to your sysop to stop the practice of
  92. removing AV's as this is your assurance from the programmer that
  93. the file is complete and virus free.
  94.  
  95.  
  96.                               INSTALLATION
  97.                               ____________
  98.  
  99.    Installation is quite simple and straight-forward. Follow these
  100. steps and example and you should be up and running in a matter of
  101. minutes.  Although AWARD is an easy program to install on most any
  102. BBS, there may be some Sysop who has trouble.  Support is available
  103. in those situations.
  104.  
  105.  
  106.       1) Create a directory to hold all AWARD files
  107.  
  108.       2) Unzip AWARDxx.ZIP into the above directory
  109.  
  110.       3) Run INSTALL.BAT
  111.  
  112.       4) Create a configuration file, with a name of your choice
  113.          or modify the SAMPLE.CFG file which is enclosed.
  114.  
  115.       5) Create a door batch file or use the sample enclosed.
  116.  
  117.  
  118.       6) Modify your particular BBS System Menus to add the
  119.          door.  The BBS setup various depending on the type BBS   
  120.          software you are running.  We assumed you are familiar   
  121.          with the general DOOR setup on your system.  Therefore our
  122.          description includes only examples of the AWARD specific
  123.          configuration file and door batch file.  Refer to your
  124.          BBS documentation for door installation on your
  125.          particular software.
  126.  
  127.  
  128.  
  129. BBS USER FILES
  130.  
  131.      The BBS user file provides information to AWARD!!, such as COM
  132.      port, user name, time allowed in the door, etc.  This file is
  133.      necessary for AWARD to function.  The complete path\filename of
  134.      the BBS user file must be passed to AWARD.EXE as the 1st
  135.      parameter in the command line.  The user file is created by
  136.      your BBS EACH time a user runs a door....The BBS USER file has
  137.      a different name on each type of BBS.  When you create your
  138.      AWARD configuration file, you must tell AWARD the name for your
  139.      particular BBS system.
  140.   
  141.      The following is a list of the user files used by the        
  142.      BBS types we support (we included a typical path).
  143.  
  144. drive\dir\filename
  145.    C:\WILDCAT\CALLINFO.BBS              ──┐  <- For Wildcat!
  146.    C:\WC30\WCWORK\NODE1\USERINFO.DAT      │  <- For Wildcat! 3.x
  147.    C:\PCB\PCBOARD.SYS                     │  <- For PCBoard using PCBOARD.SYS
  148.                                           │     only
  149.    C:\PCB\USERS                           │  <- For PCBoard using USERS only
  150.    C:\BBS\DOOR.SYS                        │  <- For Systems which support
  151.                                           │     DOOR.SYS
  152.    C:\BBS\DORINFOx.DEF                    │  <- For QBBS/RBB/RA.  Replace x
  153.                                           │     with Node#.
  154.    C:\BBS\TRIBBS.SYS                      │  <- fOR TriBBS
  155.    C:\BBS\SFDOORS.DAT                     │  <- For Spitfire
  156.    C:\BBS\CHAIN.TXT                    ───┘  <- For WWIV
  157.  
  158.  
  159. CONFIGURATION FILE
  160.  
  161. One (and only ONE) of the above will be LINE 1 of your
  162. configuration file. You MUST specify the path and name (including
  163. any extension) correctly if you expect AWARD to find it.  Sample for
  164. Lines 2 through 10 are:
  165.  
  166.    The Parole Board BBS         <- Your BBS Name
  167.    Dennis                       <- SysOp's First Name
  168.    Maidon                       <- SysOp's Last Name
  169.    00000                        <- Registration Number
  170.    100                          <- Minimum security level allowed 
  171.                                    in door.
  172.    35                           <- Maximum questions allowed per visit
  173.                                    to the door.
  174.    C:\WC\BULL\BULL1.SCR         <- Path and Name of Color Bulletin
  175.    C:\WC\BULL\BULL1.BBS         <- Path and Name of ASCii Bulletin
  176.    WC                           <- WC Create WC!3.x specific bulls
  177.                                    PCB Create PCBoard specific bulls
  178.                                    Blank for ANSI & ASCii
  179.    2                            <- Number of times allowed to play door
  180.                                    each day.
  181.    RIP                          <- "RIP" create RIP bulletins
  182.                                    "N" do not create RIP bulls
  183.  
  184.  
  185.      Edit the Sample.CFG file to suit your individual BBS.  You
  186. must have all 12 lines and no extra characters.
  187.  
  188.   Line 1:  This line points to where AWARD.EXE will find the callers
  189.            information file.  Just include the line that your     
  190.            particular BBS uses.  DO NOT put all of them in the CFG 
  191.            file.
  192.  
  193.    Line 2:  Place the name of your BBS on this line.
  194.  
  195.    Line 3:  SysOp's first name goes here.
  196.  
  197.    Line 4:  SysOp's last name goes here.
  198.  
  199.    Line 5:  Your Registration Number goes here if registered.  If
  200.             you haven't registered you can still use the          
  201.             door...just enter 00000 until you get your registration 
  202.             number.
  203.  
  204.    Line 6:  The minimum security level that is allowed in the door.
  205.  
  206.    Line 7:  Maximum number of questions allowed per visit to the door.
  207.             I would suggest 25-30 as a reasonable number.  The smaller
  208.             this number, the more likely that the users will continue to
  209.             use the door.
  210.  
  211.    Line 8:  Enter the complete path and name of the ANSI bulletin
  212.             that you want AWARD to create.
  213.  
  214.    Line 9:  Enter the complete path and name of the ASCii bulletin
  215.             that  you want AWARD to create.
  216.  
  217.    Line 10:  "WC" to create WC!3.x specific bulletins or NO for ANSI and
  218.              ASCii bulletins. "PCB" on this line will enable the program
  219.              to create PCBoard specific color bulletins.  If you Config
  220.              for WC! or PCB bulletins, Place the name of the bulletin
  221.              on Line 8 of the CFG file.  Be sure to add the ".BBS"
  222.              extension to it.  You may leave Line 9 blank but it still
  223.              MUST be included in the CFG file.
  224.  
  225.     Line 11: Number of times users are allowed to enter the door each
  226.              day.
  227.  
  228.     Line 12:  Place "RIP" on this line if you wish to create RIP styple
  229.               bulletins.  If you do not support or need them, place an
  230.               "N" on this line.
  231.  
  232.  
  233.          If you use the sample CFG file be sure to remove all
  234. remarks and use  a pure ASCII editor such as EDLIN or QEDIT.  Word
  235. processors typically leave hidden control codes. Those hidden codes
  236. could cause the program to depart for worlds unknown.  Save your
  237. newly edited file using any name you want....suggested AWARD1.CFG.
  238.  
  239.  
  240. DOOR BATCH FILE
  241.  
  242.          Create a batch file or modify the sample AWARD.BAT file
  243.          supplied. This is what you need:
  244.  
  245.   @ECHO OFF
  246.   CLS                   Keeps a clean screen (optional)
  247.   CD \DOORS\AWARD      Change to the AWARD door files directory
  248.   AWARD AWARD1.CFG    Run AWARD using AWARD1.CFG configuration
  249.                           Change back to the WCAT BBS directory
  250.                           Restart the BBS.  On BBSs which shell to
  251.                           dos to run the door this line may be    
  252.                           omitted or maybe the word "EXIT."  Check 
  253.                           your BBS door instructions.
  254.  
  255. The above DOOR.BAT file is for a Wildcat! 3.x system using SWAP instead
  256. of TERMINATE for doors.
  257.  
  258. MULTIPLE NODES
  259.  
  260.         Create a configuration file for each node.  Each file     
  261.         should have a unique name.  
  262.  
  263.         EX: AWARD1.CFG  AWARD2.CFG
  264.  
  265.         AWARD has been tested under LIVECAT and DESQVIEW and performs
  266.         very well under either or both.
  267.  
  268.  
  269.  
  270. COMM PORT IRQs
  271.  
  272. AWARD is written using DoorFrame.   DoorFrame supports COM 1-4 on the
  273. standard IRQ's - COM1 or COM3 as a standard uses IRQ4 while  COM2
  274. and COM4 use IRQ3.  If your system uses a non-standard IRQ, add the
  275. IRQ  number after the configuration filename. Let's assume your
  276. Door is called FOOBAR and you want to use COM1 but non-standard
  277. IRQ5. The command line  passed to your Door would be:
  278.  
  279.         FOOBAR FOOBAR.CFG /5
  280.         FOOBAR FOOBAR.CFG *5
  281.  
  282.       The /5 tells DoorFrame to use IRQ5 rather than the standard
  283. IRQ4 normally used with COM1. No /x parameter is needed for the
  284. standard IRQ's.
  285.  
  286. Fossil Driver Support
  287. ---------------------
  288. CatList supports the use of Fossil drivers.  To tell your Door to use the
  289. Fossil driver instead of the standard COM ports, just put /FD on the command
  290. line when running the door. For example:
  291.  
  292.      MYDOOR MYDOOR.CFG /FD
  293.      MYDOOR MYDOOR.CFG *FD
  294.  
  295. indicates that a Fossil driver is present and should be used. If no Fossil
  296. driver is detected, CatList will print a message to that effect and exit
  297. the door gracefully.
  298.  
  299.  
  300. TIPS AND TRAPS
  301.  
  302.       Be sure to read all the READ.ME, README.1ST AND UPGRADE.DOC
  303. files if they are included in the package.  They sometimes contain
  304. some very useful information. <G>  
  305. Of course you can do like me, just set the darn thing up without
  306. the docs then fuss at the door author for not making it simple
  307. enough to work the first time.
  308.  
  309.       IF You get an error...check every path to make sure you typed
  310. it correctly.  Check the file name...does it match exactly?  Does
  311. the configuration filename match?  Did you leave off the
  312. configuration file extension?   Do you have the correct BRUN module
  313. in a directory on your path?  If all those seem correct and the
  314. door still won't work...call me......preferably not in the middle
  315. of the night...no door is that important.
  316.  
  317.       When the door is in use...you can use the sysop options
  318. listed at the bottom of your screen to chat, increase or decrease
  319. the users time or log the user off.
  320.  
  321.  
  322.  
  323.  
  324.                                 MISCELLANEOUS NOTES
  325.                                 ===================
  326.  
  327. DoorFrame requires DOS 3.x and up since all files are opened in SHARED mode.
  328.  
  329. When using PCBOARD.SYS, AWARD requires that PCBOARD.DAT be in the same
  330. directory as PCBOARD.SYS. AWARD also accesses the USERS file.
  331.  
  332. When using USERS.SYS, AWARD also accesses PCBOARD.SYS, PCBOARD.DAT and the
  333. USERS file.
  334.  
  335. The DOOR.SYS used by AWARD is the standard 52 line GAP (tm) file.
  336.  
  337. The CALLINFO.BBS used by AWARD currently contains 36 lines.
  338.  
  339. DoorFrame doors may now make use of the IRQ environment variable. For
  340. example, instead of DOOR DOOR.CFG /5 you can use DOOR DOOR.CFG /%IRQ%.
  341. (I use this method here on The Parole Board for WC! and it works just
  342. fine.  Use "/%WCIRQID%".)
  343.  
  344. DoorFrame is now aware of the PCBoard environment variables %PCBDRIVE% and
  345. %PCBDIR%. If it finds those two variables on the first line of the .CFG
  346. file it will substitute the correct drive and path.
  347.  
  348.  
  349.  
  350.                               LEGALITIES
  351.                               __________
  352.  
  353.  
  354.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS
  355. IS"  WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT
  356. NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND
  357. FITNESS  FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE
  358. INVOLVED WITH THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE
  359. FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY
  360. USE THEREOF OR BREACH OF ANY WARRANTY.
  361.  
  362.  
  363.                              DISTRIBUTION
  364.                              ____________
  365.  
  366.    You may make this file available for downloading from your BBS
  367. or you may  upload it to any BBS of your choice, provided that you
  368. do not make any  changes to the contents of the archive (ZIP file).
  369. The archive and its  individual contents may not be used by any
  370. service that charges any money whatsoever, without the written
  371. permission of the author.
  372.  
  373.                              REGISTRATION
  374.                              ____________
  375.  
  376.    I am not a subscriber to the "Crippleware" concept, and this
  377. program  reflects that philosophy. This is a full-featured program,
  378. whose functionality is not hampered in any way, whether you
  379. register it or not.  It is only $15 to register this door.  Registered
  380. SysOps will receive an added utility that will allow you to edit and/or
  381. add questions to the database.  There is a 10 second delay that is
  382. removed once the program has been registered.
  383.  
  384.  
  385.                                  THANKS
  386.                              --------------
  387.  
  388.     Special thanks goes out for my wife who is definitely a
  389.     "Computer Widow".
  390.  
  391.     Ted Freeman the author of DoorFrame, a first class BBS Doors
  392.     Development Library.
  393.  
  394.     My BBS users who have had to endure constant badgering to help 
  395.     me test the programs that I have written.
  396.  
  397.     A *VERY SPECIAL THANKS* to Mustang! Software for developing the 
  398.     greatest BBS Software on the market, WILDCAT! 3.x.
  399.  
  400.     Liane Benway, SysOp, Running Wild !!! in Norcross, GA.  Without
  401.     Liane, you wouldn't have these fine DOCs.
  402.  
  403.     Ned Attayek, SysOp, Free Advice BBS in Smithfield, NC for his
  404.     tireless effort in coming up with all these questions.
  405.  
  406.     Award Trivia is written using MicroSoft's Visual Basic for DOS
  407.     v1.0.  VB/DOS is copyright 1992, MicroSoft Inc.
  408.  
  409.